<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Whisper: IPacketSource Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Whisper
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">IPacketSource Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="IPacketSource" -->
<p>packet source implementing a packet-based protocol  
 <a href="classIPacketSource.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="packet__source_8h_source.html">packet_source.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for IPacketSource:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classIPacketSource.png" usemap="#IPacketSource_map" alt=""/>
  <map id="IPacketSource_map" name="IPacketSource_map">
<area href="classCDatagramBuilder.html" title="datagram builder for communication" alt="CDatagramBuilder" shape="rect" coords="0,56,115,80"/>
<area href="classCStreamBuilder.html" title="stream builder for guaranteed stream communication" alt="CStreamBuilder" shape="rect" coords="125,56,240,80"/>
</map>
 </div></div>

<p><a href="classIPacketSource-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIPacketSource.html#a5f53142d90067b3bf06946c5153d7202">IPacketSource</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIPacketSource.html#aade4d01ce5fa23ce4efa867480e497fb">~IPacketSource</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceNPacketSource.html#a41d32c941906c55fd056bc4be5e0c79b">NPacketSource::EPayloadInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIPacketSource.html#a646c3a5cc1c03628145471697b1abf54">getPacket</a> (void *&amp;pPacket, unsigned int &amp;pPacketLength, unsigned int pMaxLength)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIPacketSource.html#ad2c03d2e3370eef80a207617bd561f26">putPacket</a> (void *pPacket, unsigned int pPacketLength)=0</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>packet source implementing a packet-based protocol </p>
<dl class="author"><dt><b>Author:</b></dt><dd>jwurzer, mnutzinger </dd></dl>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5f53142d90067b3bf06946c5153d7202"></a><!-- doxytag: member="IPacketSource::IPacketSource" ref="a5f53142d90067b3bf06946c5153d7202" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IPacketSource::IPacketSource </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="aade4d01ce5fa23ce4efa867480e497fb"></a><!-- doxytag: member="IPacketSource::~IPacketSource" ref="aade4d01ce5fa23ce4efa867480e497fb" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual IPacketSource::~IPacketSource </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a646c3a5cc1c03628145471697b1abf54"></a><!-- doxytag: member="IPacketSource::getPacket" ref="a646c3a5cc1c03628145471697b1abf54" args="(void *&amp;pPacket, unsigned int &amp;pPacketLength, unsigned int pMaxLength)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="namespaceNPacketSource.html#a41d32c941906c55fd056bc4be5e0c79b">NPacketSource::EPayloadInfo</a> IPacketSource::getPacket </td>
          <td>(</td>
          <td class="paramtype">void *&amp;&#160;</td>
          <td class="paramname"><em>pPacket</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int &amp;&#160;</td>
          <td class="paramname"><em>pPacketLength</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>pMaxLength</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>get a packet from the packet source (from upper to lower layer) </p>
<dl class="note"><dt><b>Note:</b></dt><dd>pPacket and pPacketLength only make sense if return value is true </dd>
<dd>
minimum payload length is always 1 (if return value of true)</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">pPacket</td><td>pointer to the bytes representing the packet </td></tr>
    <tr><td class="paramname">pPacketLength</td><td>number of bytes </td></tr>
    <tr><td class="paramname">pMaxLength</td><td>maximum number of bytes for the returned packet </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on data available, false otherwise </dd></dl>

<p>Implemented in <a class="el" href="classCStreamBuilder.html#a2a74e55838f864d369c88b24508f19fb">CStreamBuilder</a>, and <a class="el" href="classCDatagramBuilder.html#a181dc65bc7cda68d55ac289dfff4e241">CDatagramBuilder</a>.</p>

</div>
</div>
<a class="anchor" id="ad2c03d2e3370eef80a207617bd561f26"></a><!-- doxytag: member="IPacketSource::putPacket" ref="ad2c03d2e3370eef80a207617bd561f26" args="(void *pPacket, unsigned int pPacketLength)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void IPacketSource::putPacket </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>pPacket</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>pPacketLength</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>put a packet to the packet source (from lower to upper layer)</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">pPacket</td><td>pointer to the bytes representing the packet </td></tr>
    <tr><td class="paramname">pPacketLength</td><td>number of bytes </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classCStreamBuilder.html#ad3fb845b492550facda63badddda0ada">CStreamBuilder</a>, and <a class="el" href="classCDatagramBuilder.html#a1819520ff57281331f9b202e2aa5772d">CDatagramBuilder</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="packet__source_8h_source.html">packet_source.h</a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 25 2012 22:00:47 for Whisper by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
